<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilnvm: XilNVM mailbox APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilnvm
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xnvm__mailbox__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilNVM mailbox APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3ce66c6266190912ba2552c2bc1701c7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__mailbox__apis.html#ga3ce66c6266190912ba2552c2bc1701c7">XNvm_ProcessMailbox</a> (XMailbox *MailboxPtr, u32 *MsgPtr, u32 MsgLen)</td></tr>
<tr class="memdesc:ga3ce66c6266190912ba2552c2bc1701c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to the target module and gets the response from it.  <a href="#ga3ce66c6266190912ba2552c2bc1701c7">More...</a><br/></td></tr>
<tr class="separator:ga3ce66c6266190912ba2552c2bc1701c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga051799e29b90346a34e49e8fddfc10e5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__mailbox__apis.html#ga051799e29b90346a34e49e8fddfc10e5">XNvm_ClientInit</a> (XNvm_ClientInstance *const InstancePtr, XMailbox *const MailboxPtr)</td></tr>
<tr class="memdesc:ga051799e29b90346a34e49e8fddfc10e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the instance of mailbox.  <a href="#ga051799e29b90346a34e49e8fddfc10e5">More...</a><br/></td></tr>
<tr class="separator:ga051799e29b90346a34e49e8fddfc10e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga051799e29b90346a34e49e8fddfc10e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_ClientInit </td>
          <td>(</td>
          <td class="paramtype">XNvm_ClientInstance *const&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XMailbox *const&#160;</td>
          <td class="paramname"><em>MailboxPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the instance of mailbox. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">MailboxPtr</td><td>Pointer to the mailbox instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On successful initialization</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Perform input parameter validation on InstancePtr. If not NULL initialize the InstancePtr, else return XST_FAILURE.</p>

<p>Referenced by <a class="el" href="group__xnvm__apis.html#ga840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ga3ce66c6266190912ba2552c2bc1701c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_ProcessMailbox </td>
          <td>(</td>
          <td class="paramtype">XMailbox *&#160;</td>
          <td class="paramname"><em>MailboxPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to the target module and gets the response from it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">MailboxPtr</td><td>Pointer to mailbox instance </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>Pointer to the payload message </td></tr>
    <tr><td class="paramname">MsgLen</td><td>Length of the message</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS If the IPI send and receive is successful</li>
<li>XST_FAILURE If there is a failure</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Payload consists of API id and call arguments to be written in IPI buffer </dd></dl>
<p>Send IPI CDO to PLM. Return XST_FAILURE, if failure in IPI send request.</p>
<p>Wait for IPI response from PLM with a default timeout of 300 seconds. If the timeout exceeds, then error is returned otherwise it returns the status of the IPI response.</p>

<p>Referenced by <a class="el" href="group__xnvm__bbram__client__api.html#ga5ab6ca734ee3f575632ba1c88164d182">XNvm_BbramLockUsrDataWrite()</a>, <a class="el" href="group__xnvm__bbram__client__api.html#ga8cdf06389845d0a30a2d48ae3373b72b">XNvm_BbramReadUsrData()</a>, <a class="el" href="group__xnvm__bbram__client__api.html#ga3a9878e9a0eb1071cd34c4d14d842f10">XNvm_BbramWriteAesKey()</a>, <a class="el" href="group__xnvm__bbram__client__api.html#ga99bad6a63ce3e2663bd7976371598b4f">XNvm_BbramWriteUsrData()</a>, <a class="el" href="group__xnvm__bbram__client__api.html#gae4085a2c2243377cae4029f3236684e7">XNvm_BbramZeroize()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaa14ae0e8b42bf8801a510e2f31e29c88">XNvm_EfuseReadBootEnvCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga9d3f76422408b4102f47ad332ebb3a8a">XNvm_EfuseReadBootModeDis()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga15ea0137369d9a81a853a6784c43b29d">XNvm_EfuseReadDecOnly()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaa5cc5a2ddb36b51e0f5b160844c262e6">XNvm_EfuseReadDmeMode()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gacb7ff4ed433334fd4c7af398a6698be6">XNvm_EfuseReadDna()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaf63250e1f6043e6715870670a4fd1695">XNvm_EfuseReadFipsInfoBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gabbff97b78f82ae83002d64c9e4e61964">XNvm_EfuseReadIv()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaf3ba1177b7892366982f77d32ec7ecf8">XNvm_EfuseReadMiscCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga55a6be49ea504c9e07a532b5e82797c1">XNvm_EfuseReadOffchipRevokeId()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gad7ea5c5b0c9de1c1e6b4c2659a02ddeb">XNvm_EfuseReadPpkHash()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga6a1e538568cd6b7e21084eaf138a3113">XNvm_EfuseReadPuf()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gae98054231a90a3ded1ec82c9a011ac94">XNvm_EfuseReadPufSecCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga32e43ec62893f850f115f3ee0a5434f9">XNvm_EfuseReadRevocationId()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gadf4cc0221b64537c48fd20e455ae0922">XNvm_EfuseReadRomRsvdBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gae6cbda607227cfb4778b66c8c2a8ebf0">XNvm_EfuseReadSecCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gacc863c22d5d7a8f54f7d3cb28781a82e">XNvm_EfuseReadSecMisc1Bits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga1a3da417c5ca5121f4c8d375bf0ea298">XNvm_EfuseReadUserFuses()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga6615e748856e15f3e2169f9413e7cbd1">XNvm_EfuseRevokePpk()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaefb1c21b807d6bb2cd0725d0bdc473af">XNvm_EfuseWrite()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga9bb1800b8836e8b5b93a2f3280ffd028">XNvm_EfuseWriteBootEnvCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaaefd51d906cc8e0ab94021cc66117db7">XNvm_EfuseWriteBootModeDis()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga3fe9a35b9f742edadd32e748601834af">XNvm_EfuseWriteDecOnly()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga0451643f0fb100232b825a43e98dc31f">XNvm_EfuseWriteDiceUds()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga2fe80756c7fd8ac54259cb078673b929">XNvm_EfuseWriteDmeMode()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gaa3d72c2fc1303437a2bd30a1984e3e81">XNvm_EfuseWriteFipsInfo()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga75863c5bebf00e95dff382a754c77473">XNvm_EfuseWriteGlitchConfigBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga7ed0e93e0e8a58ecfc5dd60e42461c15">XNvm_EfuseWriteIVs()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gab876f823d2385d13f6d16654464bcd4b">XNvm_EfuseWriteMiscCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gac15adc21769d673aa1e7f3bf371e9eb5">XNvm_EfuseWriteOffChipRevocationId()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga23cf0605525481bcf5f286ec6de7523e">XNvm_EfuseWritePlmUpdate()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gad260093cbe9bacb6d0f649b84bccd8a0">XNvm_EfuseWritePuf()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga64be6dbb240bc0ae308f7e8463dbfbed">XNvm_EfuseWritePufCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gae09868a910eea80203d78873f4de064c">XNvm_EfuseWriteRevocationId()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gad3821263965e76d7205032b8b37d6d2a">XNvm_EfuseWriteRomRsvdBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga0fff3a9010545e93ce2653cce3dd7cb2">XNvm_EfuseWriteSecCtrlBits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#ga5035ae74158206735b20af385432738a">XNvm_EfuseWriteSecMisc1Bits()</a>, <a class="el" href="group__xnvm__efuse__client__apis.html#gab49aedef8afbe4faa8a842b847cece3c">XNvm_EfuseWriteUserFuses()</a>, and <a class="el" href="group__xnvm__efuse__client__apis.html#ga5b4ffffd504310ff58b4d21f0308ff04">XNvm_WriteDmePrivateKey()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
